Skip to content

Declare the landing-page class of OGC API - Common - Part 1 - #90

Merged
estebanzimanyi merged 1 commit into
masterfrom
feat/common-landing-page-class
Nov 19, 2026
Merged

estebanzimanyi merged 1 commit into
masterfrom
feat/common-landing-page-class

Conversation

@estebanzimanyi

Copy link
Copy Markdown
Member

The class landing-page of OGC API - Common - Part 1 (OGC 19-072): its declaration, the link it requires, and a test row per abstract test.

What the class is

Common Part 1 places the landing page, the API definition and the conformance declaration in the class http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/landing-page, six abstract tests: root-op, root-success, api-definition-op, api-definition-success, conformance-op, conformance-success. Its core holds the HTTP and query-parameter tests only. The service serves the three resources and declares the class, and the three routes are marked with it.

The conformance link

Two standards require the link from the landing page to the conformance declaration, each under its own relation type:

  • OGC API - Features - Part 1, /req/core/root-success, on which Moving Features builds: conformance;
  • Common Part 1, /req/landing-page/root-success: http://www.opengis.net/def/rel/ogc/1.0/conformance.

The landing page links /conformance under both (relConformance), as the conformance declaration names a class under each spelling its standards publish.

The API definition

/conf/landing-page/api-definition-success validates the API definition against a schema. The OpenAPI 3.0 schema the OpenAPI Initiative publishes is vendored byte for byte in openapi/oas-3.0-schema.json, with its URL and sha256 in openapi/README.md. Against it, the four EDR operations (position, area, trajectory, corridor) state no responses, which OpenAPI 3.0 requires of every operation; edrPaths gives them the 200 response every other operation states.

The tests

ats_common_test.go holds a row per abstract test, each naming its test, read through the routing table the service runs (newMux):

  • TestCommonLandingPage: 200, the landingPage schema, and the service-desc, both conformance and data links;
  • TestCommonAPIDefinition: 200 and the OpenAPI 3.0 schema, with two documents the schema must refuse;
  • TestCommonConformanceDeclaration: 200, the confClasses schema, and core and landing-page listed.

The landingPage, confClasses and link schemas of the vendored Moving Features document state the constraints of Common's landingPage.yaml, confClasses.yaml and link.yaml: the same required members, of the same types. TestCommonLandingPage fails with the Common relation type removed from the landing page.

The samples of the landing page, the conformance declaration and the API definition, and api/surface.json, are what the code writes.

The landing page, the API definition and the conformance declaration are
the resources of the class landing-page of Common Part 1 (OGC 19-072),
whose core holds only the HTTP and query-parameter tests. The service
serves the three and declared core alone.

Common Part 1 requires the landing page to link the conformance
declaration under the relation type
http://www.opengis.net/def/rel/ogc/1.0/conformance
(/req/landing-page/root-success), and Features Part 1, on which Moving
Features builds, under conformance (/req/core/root-success). The landing
page links it under both. The three routes are marked with landing-page.

ats_common_test.go holds a row per abstract test of the class, each read
through the routing table the service runs. The API definition is
validated against the OpenAPI 3.0 schema, vendored byte for byte in
openapi/; it found the four EDR operations stating no responses, which
OpenAPI 3.0 requires of every operation, and they state them.
@estebanzimanyi
estebanzimanyi merged commit 459a02d into master Nov 19, 2026
2 checks passed
@estebanzimanyi
estebanzimanyi deleted the feat/common-landing-page-class branch November 19, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant